/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.spring.initializr.generator.project.contributor;

import org.springframework.core.Ordered;

import java.io.IOException;
import java.nio.file.Path;

/**
 * spring-initializr 提供了 2 种主要扩展途径：ProjectContributor 和 xxxCustomizer。
 * <p>
 * 对生成的项目进行贡献的回调。 emmm确实是贡献的意思，可能是指生成示例代码 Invoked with an {@link Ordered order} of
 * {@code 0} by default, considering overriding {@link #getOrder()} to customize this
 * behaviour.
 * <p>
 * 其典型的实现可参考下列实现类： MavenBuildProjectContributor：写入 maven 项目 pom.xml 文件；
 * WebFoldersContributor：创建 web 项目的资源文件夹； ApplicationPropertiesContributor：写入
 * application.properties 文件； MainSourceCodeProjectContributor：写入应用入口类 xxxApplication.java
 * 文件； HelpDocumentProjectContributor：写入帮助文档 HELP.md 文件。
 *
 * @author Andy Wilkinson
 */
@FunctionalInterface
public interface ProjectContributor extends Ordered {

	/**
	 * 向指定根目录中的项目贡献其他资源。 从方法签名就可以看出，入参只有一个项目的根路径， 其职责就是向这个路径下些人项目文件。
	 * 这个扩展点非常的灵活，几乎可以支持任何的代码、配置文件写入工作。
	 * <p>
	 * 实现过程中，可以通过 ProjectGenerationContext 获取相关依赖，然后通过自定义逻辑完成文件生成工作。
	 * @param projectRoot the root directory of the project
	 * @throws IOException if contributing a resource failed
	 */
	void contribute(Path projectRoot) throws IOException;

	@Override
	default int getOrder() {
		return 0;
	}

}
